mkdocs plugins
Mkdocs plugins and extensions that i used
Table of Content
mkdocs-material#
Speak for itself Getting started
MkDocs Awesome Pages#
The awesome-pages plugin allows you to customize how your pages show up the navigation of your MkDocs without having to configure the full structure in your mkdocs.yml
For more info
install
pip install mkdocs-awesome-pages-plugin
yml config
plugins:
- awesome-pages
Usage#
Create .pages file in subdirectory to order
nav:
- subdirectory
- page1.md
- page2.md
Note
More examples in project README
mkdocs-jupyter#
Use Jupyter Notebooks in mkdocs
github

install
pip install mkdocs-jupyter
Usage#
mkdocs.yml
plugins:
- mkdocs-jupyter
- The first h1 header (#) in your notebook will be used as the title.
Video#
This plugin allows you to embed videos on the documentation pages using a simple Markdown syntax. github
install
pip install mkdocs-video
config#
mkdocs.yml
plugins:
- mkdocs-video
usage#
